Add Markdown and plaintext output systems #929
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
LGTM 🚀
|
| @@ -57,7 +57,6 @@ export const VISION_MODEL_ID = "vision" | |||
| export const DEFAULT_FENCE_FORMAT: FenceFormat = "xml" | |||
| export const DEFAULT_MODEL = "openai:gpt-4o" | |||
| export const DEFAULT_MODEL_CANDIDATES = [ | |||
| "azure:gpt-4o", | |||
| "azure_serverless:gpt-4o", | |||
| DEFAULT_MODEL, | |||
| "google:gemini-1.5-pro-latest", | |||
There was a problem hiding this comment.
The export DEFAULT_MODEL_CANDIDATES is unused and can be removed.
generated by pr-review-commit
unused_export
| @@ -5,7 +5,6 @@ import type { | |||
| ImageContent, | |||
There was a problem hiding this comment.
The import of YAMLStringify from "./yaml" is unused and can be removed.
generated by pr-review-commit
unused_import
| @@ -36,6 +36,7 @@ export function resolveSystems( | |||
| // Default systems if no responseType is specified | |||
| if (!script.responseType) { | |||
| systems.push("system") | |||
| systems.push("system.output_markdown") | |||
| systems.push("system.explanations") | |||
There was a problem hiding this comment.
The push operation for "system.output_markdown" is unnecessary as it's already included in the default systems.
generated by pr-review-commit
unnecessary_push
| @@ -58,7 +58,7 @@ This is what the `basic.prompty` file compiles to: | |||
|
|
|||
There was a problem hiding this comment.
The model name has been changed from "azure:gpt-4o" to "openai:gpt-4o". Ensure that the new model is compatible and available in your environment.
generated by pr-docs-review-commit
model_change
| $`- You are concise. | ||
| - Answer in markdown. | ||
| ` | ||
| $`- You are concise.` |
There was a problem hiding this comment.
The markdown syntax for code blocks should be consistent. Use triple backticks (```) instead of ````` to define code blocks.
generated by pr-docs-review-commit
markdown_syntax
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The headings for the new sections should be consistent with the existing headings. Use ## instead of ### for subheadings.
generated by pr-docs-review-commit
markdown_heading
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The code snippets within the new sections are not properly formatted. Ensure that each snippet is enclosed in triple backticks (```) and has a language identifier if applicable.
generated by pr-docs-review-commit
markdown_code_snippet
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The links within the code snippets should be consistent with the existing documentation. Ensure that all links are properly formatted and accessible.
generated by pr-docs-review-commit
markdown_link
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The tables within the new sections are not properly formatted. Ensure that each table is enclosed in triple backticks (```) and has a header row if applicable.
generated by pr-docs-review-commit
markdown_table
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The lists within the new sections should be consistent with the existing documentation. Ensure that all lists are properly formatted and have proper indentation.
generated by pr-docs-review-commit
markdown_list
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The quotes within the code snippets should be consistent with the existing documentation. Ensure that all quotes are properly formatted and do not interfere with the syntax of the code.
generated by pr-docs-review-commit
markdown_quote
| $`- You are concise. | ||
| - Answer in markdown. | ||
| ` | ||
| $`- You are concise.` |
There was a problem hiding this comment.
The markdown syntax for code blocks should be consistent. Use triple backticks (```) instead of ````` to define code blocks.
generated by pr-docs-review-commit
markdown_syntax
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The structure of the documentation is inconsistent. The new sections system.output_markdown and system.output_plaintext are not properly formatted and do not follow the existing structure of the document.
generated by pr-docs-review-commit
structure_error
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The headings for the new sections should be consistent with the existing headings. Use ## instead of ### for subheadings.
generated by pr-docs-review-commit
markdown_heading
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The code snippets within the new sections are not properly formatted. Ensure that each snippet is enclosed in triple backticks (```) and has a language identifier if applicable.
generated by pr-docs-review-commit
markdown_code_snippet
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The links within the code snippets should be consistent with the existing documentation. Ensure that all links are properly formatted and accessible.
generated by pr-docs-review-commit
markdown_link
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The tables within the new sections are not properly formatted. Ensure that each table is enclosed in triple backticks (```) and has a header row if applicable.
generated by pr-docs-review-commit
markdown_table
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The lists within the new sections should be consistent with the existing documentation. Ensure that all lists are properly formatted and have proper indentation.
generated by pr-docs-review-commit
markdown_list
|
|
||
| ````` | ||
|
|
||
|
|
||
| ### `system.planner` |
There was a problem hiding this comment.
The quotes within the code snippets should be consistent with the existing documentation. Ensure that all quotes are properly formatted and do not interfere with the syntax of the code.
generated by pr-docs-review-commit
markdown_quote
Introduce systems for Markdown and plaintext output, enhancing the response capabilities of the application.
system.output_markdown) 📝system.output_markdownto the list of responses